Syntaxe des commandes

Cette section présente la composition d'une commande et introduit les différents termes de vocabulaire qui seront utilisés par la suite.

Une commande se découpe en cinq parties principales :

Sous Windows / UNIX / OpenVMS, la syntaxe est la suivante :

Commande Objet Environnement Items Entrée-Sortie

Sous OS/400, le programme associé à la commande peut être appelé avec la syntaxe suivante :

CALL PGM(PROGRAMME) PARM(Objet Environnement Items Entrée-Sortie)

Description des items

• Commande / PROGRAMME

  Verbe de la commande utilisée. Le verbe de la commande doit toujours être cité en premier. Si le répertoire de travail courant n'est pas le répertoire UNI_DIR_EXEC, celui-ci doit être précisé dans la commande (sauf sur OpenVMS). Sous OS/400, la librairie Société doit être chargée.

  Exemple : sous UNIX, la commande uxlst affiche la liste des objets du type :

  ${UNI_DIR_EXEC}/uxlst UPR

• Objet

  Mot-clé indiquant l'objet ou la fonction activée. L'objet doit toujours être saisi en second à la suite du verbe de la commande, les items étant décrits par la suite dans un ordre quelconque.

  Dans l'exemple ci-dessous le mot-clé est UPR. Il spécifie que la commande porte sur les objets de type Uprocs.

  ${UNI_DIR_EXEC}/uxlst UPR

• Environnement

  Environnement de travail : nœud, espace et éventuellement unité de gestion.

  Le fichier unienv (dans le répertoire principal de la société) doit être exécuté préalablement pour charger l'environnement par défaut. Les informations ci-dessous permettent de modifier ces valeurs :

  • NODE=

    Nom de nœud Dollar Universe. Toutes les commandes ne peuvent concerner que des nœuds d'une même Société.
    

    Si la commande cible un nom de nœud distant, celui-ci doit être déclaré sur le même UVMS que le nœud Dollar Universe local ou, dans le cas d'une architecture "UVMS maître / UVMS subordonnés", sur un UVMS subordonné (du même maître) partageant ses nœuds.

    Sous Windows / UNIX / OpenVMS, si le nœud n'est pas spécifié, la valeur de la variable S_NODENAME sera utilisée par défaut.
    Format : 64 caractères alphanumériques.

    Sous OS/400 en mode affichage, si le nœud n'est pas spécifié, le nœud courant (*CURRENT) est utilisé.

  • EXP | SIM | INT |APP

    Valide pour les commandes de paramétrage et d'exploitation.

    Espace dans lequel la commande doit s'exécuter. Saisissez :

    • EXP pour l'espace d'exploitation,
    • SIM pour l'espace simulation,
    • INT pour l'espace intégration,
    • APP pour l'espace application.
      

    Défaut :

    • Sous Windows / UNIX / OpenVMS : valeur de la variable S_ESPEXE.
      
    • Sous OS/400 : *CURRENT est utilisé

  • ESP=

    Valide pour les commandes de gestion de batch et les commandes DQM.

    Espace dans lequel la commande doit s'exécuter. Saisissez :

    • X pour l'espace d'exploitation
    • S pour l'espace de simulation
    • I pour l'espace d'intégration
    • A pour l'espace d'application

    Défaut : valeur de la variable S_ESPEXE

• Items

  Enregistrements de travail définissant les informations souhaitées. Sous OS/400, tous les items doivent être cités entre apostrophes, par exemple : 'MU=MYMU'.

  Pour chaque commande, une liste d'items est détaillée :

  • Un item optionnel est présenté entre crochets [ ].
  • Une valeur surlignée indique la valeur par défaut.
  • "*" (astérisque) souligne la possibilité de saisir une valeur générique pour l'item concerné.

• Entrée-Sortie

  Définition des fichiers contenant des informations en "entrée" de la fonction (INPUT=fichier) ou de recueil des informations en "sortie" (OUTPUT=fichier).

  Les items INPUT et OUTPUT sont principalement utilisés avec les commandes d'extraction et d'insertion uxext et uxins proposées par Dollar Universe afin de permettre une interface facilitée avec un produit de télédistribution par exemple.

  L'item output peut également être utilisé par les commandes uxshw ou uxlst pour recueillir les informations dans un fichier à la place de l'affichage à l'écran (valeur par défaut).

  Un même fichier de sortie peut être utilisé pour un ensemble de commandes uxext (pouvant porter sur des objets différents), les données extraites étant ajoutées en fin de fichier à celles déjà extraites par les commandes précédentes.

  Il est cependant recommandé de ne pas utiliser le même fichier de sortie pour des objets appartenant à des espaces différents, dans ce dernier cas l’utilisation de caractères génériques sur les version d’objets (Uprocs, session et tâches), pourrait générer des confusions. Par exemple, si le même fichier contient le résultat des deux commandes suivantes :

  uxext UPR APP UPR="*" VUPR="*" OUTPUT=fichier

  uxext UPR INT UPR="*" VUPR="*" OUTPUT=fichier

  Si le même couple (Uproc, version) existe dans les deux espaces, et comme l'item REPL n'est pas indiqué seule l'Uproc version de l'espace application sera inséré dans le fichier.

  Si l'item REPL était indiqué dans la deuxième commande, seule l'Uproc version de l'espace intégration persistera dans le fichier (en écrasant la définition donnée en espace application).

Code retour

Les codes retournés par les commandes sont les suivants :

• 0 (ou nombre impair sous OpenVMS) : la commande a été exécutée correctement,

• 1 (ou nombre pair sous OpenVMS): la commande n'a pas pu être exécutée correctement, un message explique la raison de l'échec : erreur de syntaxe, serveur d'I/O absent ...

• 255 ou -1 : la commande a été exécutée correctement mais n'avait rien à faire (par exemple: pas d'événements à supprimer).